home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3dm / fx / fxMovieRenderImage.z / fxMovieRenderImage
Encoding:
Text File  |  2002-10-03  |  13.1 KB  |  199 lines
  1.  
  2.  
  3.  
  4. ddddmmmmFFFFXXXXMMMMoooovvvviiiieeeeRRRReeeennnnddddeeeerrrrIIIImmmmaaaaggggeeee((((3333ddddmmmm))))                            ddddmmmmFFFFXXXXMMMMoooovvvviiiieeeeRRRReeeennnnddddeeeerrrrIIIImmmmaaaaggggeeee((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ddddmmmmFFFFXXXXMMMMoooovvvviiiieeeeRRRReeeennnnddddeeeerrrrIIIImmmmaaaaggggeeee, ddddmmmmFFFFXXXXMMMMoooovvvviiiieeeeIIIInnnnsssseeeerrrrttttIIIImmmmaaaaggggeeee, ddddmmmmFFFFXXXXMMMMoooovvvviiiieeeeRRRReeeennnnddddeeeerrrrFFFFiiiieeeellllddddssss,
  10.      ddddmmmmFFFFXXXXMMMMoooovvvviiiieeeeIIIInnnnsssseeeerrrrttttFFFFiiiieeeellllddddssss - transfer images between movies and special
  11.      effects
  12.  
  13.  
  14. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  15.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////ffffxxxx____bbbbuuuuffffffffeeeerrrr....hhhh>>>>
  16.  
  17.      DDDDMMMMssssttttaaaattttuuuussss ddddmmmmFFFFXXXXMMMMoooovvvviiiieeeeRRRReeeennnnddddeeeerrrrIIIImmmmaaaaggggeeee
  18.            (((( MMMMVVVViiiidddd mmmmoooovvvviiiieeee,,,,
  19.              MMMMVVVVttttiiiimmmmeeee ttttiiiimmmmeeee,,,,
  20.              MMMMVVVVttttiiiimmmmeeeessssccccaaaalllleeee ttttiiiimmmmeeeeSSSSccccaaaalllleeee,,,,
  21.              iiiinnnntttt iiiinnnnppppuuuuttttUUUUssssaaaaggggeeee,,,,
  22.              DDDDMMMMffffxxxxbbbbuuuuffffffffeeeerrrr**** ddddeeeessssttttiiiinnnnaaaattttiiiioooonnnnBBBBuuuuffffffffeeeerrrr ))))
  23.  
  24.      DDDDMMMMssssttttaaaattttuuuussss ddddmmmmFFFFXXXXMMMMoooovvvviiiieeeeIIIInnnnsssseeeerrrrttttIIIImmmmaaaaggggeeee
  25.            (((( MMMMVVVViiiidddd ttttrrrraaaacccckkkk,,,,
  26.              MMMMVVVVttttiiiimmmmeeee ttttiiiimmmmeeee,,,,
  27.              MMMMVVVVttttiiiimmmmeeee dddduuuurrrraaaattttiiiioooonnnn,,,,
  28.              MMMMVVVVttttiiiimmmmeeeessssccccaaaalllleeee ttttiiiimmmmeeeeSSSSccccaaaalllleeee,,,,
  29.              DDDDMMMMffffxxxxbbbbuuuuffffffffeeeerrrr**** ssssoooouuuurrrrcccceeeeBBBBuuuuffffffffeeeerrrr ))))
  30.  
  31.      DDDDMMMMssssttttaaaattttuuuussss ddddmmmmFFFFXXXXMMMMoooovvvviiiieeeeRRRReeeennnnddddeeeerrrrFFFFiiiieeeellllddddssss
  32.            (((( MMMMVVVViiiidddd mmmmoooovvvviiiieeee,,,,
  33.              MMMMVVVVttttiiiimmmmeeee ttttiiiimmmmeeee,,,,
  34.              MMMMVVVVttttiiiimmmmeeee dddduuuurrrraaaattttiiiioooonnnn,,,,
  35.              MMMMVVVVttttiiiimmmmeeeessssccccaaaalllleeee ttttiiiimmmmeeeeSSSSccccaaaalllleeee,,,,
  36.              DDDDMMMMffffxxxxbbbbuuuuffffffffeeeerrrr**** ddddssssttttFFFFiiiieeeellllddddAAAA,,,,
  37.              DDDDMMMMffffxxxxbbbbuuuuffffffffeeeerrrr**** ddddssssttttFFFFiiiieeeellllddddBBBB ))))
  38.  
  39.      DDDDMMMMssssttttaaaattttuuuussss ddddmmmmFFFFXXXXMMMMoooovvvviiiieeeeIIIInnnnsssseeeerrrrttttFFFFiiiieeeellllddddssss
  40.            (((( MMMMVVVViiiidddd ttttrrrraaaacccckkkk,,,,
  41.              MMMMVVVVttttiiiimmmmeeee ttttiiiimmmmeeee,,,,
  42.              MMMMVVVVttttiiiimmmmeeee dddduuuurrrraaaattttiiiioooonnnn,,,,
  43.              MMMMVVVVttttiiiimmmmeeeessssccccaaaalllleeee ttttiiiimmmmeeeeSSSSccccaaaalllleeee,,,,
  44.              DDDDMMMMffffxxxxbbbbuuuuffffffffeeeerrrr**** ssssrrrrccccFFFFiiiieeeellllddddAAAA,,,,
  45.              DDDDMMMMffffxxxxbbbbuuuuffffffffeeeerrrr**** ssssrrrrccccFFFFiiiieeeellllddddBBBB ))))
  46.  
  47.  
  48. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  49.      _m_o_v_i_e               The movie that contains the image to be rendered.
  50.  
  51.      _t_r_a_c_k               The track into which a new image is inserted.
  52.  
  53.      _t_i_m_e                A time within the movie.
  54.  
  55.      _d_u_r_a_t_i_o_n            Specifies how long an inserted image will be
  56.                          displayed when the movie is played.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. ddddmmmmFFFFXXXXMMMMoooovvvviiiieeeeRRRReeeennnnddddeeeerrrrIIIImmmmaaaaggggeeee((((3333ddddmmmm))))                            ddddmmmmFFFFXXXXMMMMoooovvvviiiieeeeRRRReeeennnnddddeeeerrrrIIIImmmmaaaaggggeeee((((3333ddddmmmm))))
  71.  
  72.  
  73.  
  74.      _t_i_m_e_S_c_a_l_e           Specifies the units for _t_i_m_e and _d_u_r_a_t_i_o_n.
  75.  
  76.      _i_n_p_u_t_U_s_a_g_e          Specifies how the image buffer will be used, a
  77.                          combination of bbbbuuuuffffIIIInnnnppppuuuuttttDDDDiiiirrrreeeecccctttt, bbbbuuuuffffIIIInnnnppppuuuuttttTTTTeeeexxxxttttuuuurrrreeee,
  78.                          bbbbuuuuffffIIIInnnnppppuuuuttttDDDDrrrraaaawwwwPPPPiiiixxxxeeeellllssss, and bbbbuuuuffffIIIInnnnppppuuuuttttMMMMoooovvvviiiieeee.
  79.  
  80.      _d_e_s_t_i_n_a_t_i_o_n_B_u_f_f_e_r   The buffer in which the resulting image is placed.
  81.  
  82.      _s_o_u_r_c_e_B_u_f_f_e_r        A buffer containing the image to be inserted into the
  83.                          movie.
  84.  
  85.      _d_s_t_F_i_e_l_d_A           Field buffer where the even numbered scanlines
  86.                          (counting from 0) of the resulting image are placed.
  87.  
  88.      _d_s_t_F_i_e_l_d_B           Field buffer where the odd numbered scanlines
  89.                          (counting from 0) of the resulting image are placed.
  90.  
  91.      _s_r_c_F_i_e_l_d_A           Field buffer which contains the even numbered
  92.                          scanlines (counting from 0) of the image to be
  93.                          inserted into the movie.
  94.  
  95.      _s_r_c_F_i_e_l_d_B           Field buffer which contains the odd numbered
  96.                          scanlines (counting from 0) of the image to be
  97.                          inserted into the movie.
  98.  
  99.  
  100. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  101.      ddddmmmmFFFFXXXXmmmmoooovvvviiiieeeeRRRReeeennnnddddeeeerrrrIIIImmmmaaaaggggeeee renders a movie at the given time (see
  102.      mmmmvvvvRRRReeeennnnddddeeeerrrrMMMMoooovvvviiiieeeeTTTTooooIIIImmmmaaaaggggeeeeBBBBuuuuffffffffeeeerrrr((((3333ddddmmmm))))), and places the result in
  103.      _d_e_s_t_i_n_a_t_i_o_n_B_u_f_f_e_r.  It is equivalent to calling
  104.      ddddmmmmFFFFXXXXSSSSeeeettttuuuuppppOOOOuuuuttttppppuuuuttttIIIImmmmaaaaggggeeeeBBBBuuuuffffffffeeeerrrr, mmmmvvvvRRRReeeennnnddddeeeerrrrMMMMoooovvvviiiieeeeTTTTooooIIIImmmmaaaaggggeeeeBBBBuuuuffffffffeeeerrrr, and
  105.      ddddmmmmFFFFXXXXCCCClllleeeeaaaannnnuuuuppppOOOOuuuuttttppppuuuuttttIIIImmmmaaaaggggeeeeBBBBuuuuffffffffeeeerrrr in sequence, but may be more efficient.
  106.      ddddmmmmFFFFXXXXmmmmoooovvvviiiieeeeRRRReeeennnnddddeeeerrrrIIIImmmmaaaaggggeeee takes into account the current movie rectangle (see
  107.      mmmmvvvvSSSSeeeettttMMMMoooovvvviiiieeeeRRRReeeecccctttt((((3333ddddmmmm))))) to decide the location of the image in the buffer.
  108.  
  109.      ddddmmmmFFFFXXXXMMMMoooovvvviiiieeeeIIIInnnnsssseeeerrrrttttIIIImmmmaaaaggggeeee take a buffer containing an image, and inserts that
  110.      image in the given track at the given time.  It is equivalent to calling
  111.      ddddmmmmFFFFXXXXSSSSeeeettttuuuuppppIIIInnnnppppuuuuttttIIIImmmmaaaaggggeeeeBBBBuuuuffffffffeeeerrrr, mmmmvvvvIIIInnnnsssseeeerrrrttttFFFFrrrraaaammmmeeeessssAAAAttttTTTTiiiimmmmeeee, and
  112.      ddddmmmmFFFFXXXXCCCClllleeeeaaaannnnuuuuppppIIIInnnnppppuuuuttttIIIImmmmaaaaggggeeeeBBBBuuuuffffffffeeeerrrr in sequence, but may be more efficient.
  113.  
  114.      ddddmmmmFFFFXXXXMMMMoooovvvviiiieeeeRRRReeeennnnddddeeeerrrrFFFFiiiieeeellllddddssss renders a movie at the given time (see
  115.      mmmmvvvvRRRReeeennnnddddeeeerrrrMMMMoooovvvviiiieeeeTTTTooooIIIImmmmaaaaggggeeeeBBBBuuuuffffffffeeeerrrr((((3333ddddmmmm))))), and places the result in _d_s_t_F_i_e_l_d_A and
  116.      _d_s_t_F_i_e_l_d_B.  _d_s_t_F_i_e_l_d_A contains the even numbered scanlines (counting from
  117.      0), and _d_s_t_F_i_e_l_d_B contains the odd numbered scanlines.  It is equivalent
  118.      in functionality to calling ddddmmmmFFFFXXXXMMMMoooovvvviiiieeeeRRRReeeennnnddddeeeerrrrIIIImmmmaaaaggggeeee((((3333ddddmmmm)))) followed by
  119.      ddddmmmmFFFFXXXXSSSSpppplllliiiittttFFFFiiiieeeellllddddssss((((3333ddddmmmm)))), but might be more efficient under some conditions.
  120.  
  121.      ddddmmmmFFFFXXXXMMMMoooovvvviiiieeeeIIIInnnnsssseeeerrrrttttFFFFiiiieeeellllddddssss takes two buffers containing interlaced image data,
  122.      and inserts those fields into the given track at the given time.
  123.      _d_s_t_F_i_e_l_d_A contains the even numbered scanlines of the full image
  124.      (counting from 0) and _d_s_t_F_i_e_l_d_B contains the odd numbered scanlines.  It
  125.      is equivalent in functionality to calling _d_m_F_X_J_o_i_n_F_i_e_l_d_s(_3_d_m) followed by
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. ddddmmmmFFFFXXXXMMMMoooovvvviiiieeeeRRRReeeennnnddddeeeerrrrIIIImmmmaaaaggggeeee((((3333ddddmmmm))))                            ddddmmmmFFFFXXXXMMMMoooovvvviiiieeeeRRRReeeennnnddddeeeerrrrIIIImmmmaaaaggggeeee((((3333ddddmmmm))))
  137.  
  138.  
  139.  
  140.      _d_m_F_X_M_o_v_i_e_I_n_s_e_r_t_I_m_a_g_e(_3_d_m), but might be more efficient under some
  141.      conditions.
  142.  
  143.  
  144. RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEESSSS
  145.      All functions return DDDDMMMM____SSSSUUUUCCCCCCCCEEEESSSSSSSS if the operation was completed
  146.      successfully, and DDDDMMMM____FFFFAAAAIIIILLLLUUUURRRREEEE if not.  In the case of failure, error
  147.      information can be obtained from ddddmmmmGGGGeeeettttEEEErrrrrrrroooorrrr((((3333ddddmmmm)))).
  148.  
  149.  
  150. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  151.      dmFXAllocateImageBuffers(3dm), dmFXSetupInputImageBuffer(3dm),
  152.      dmFXSetupScanlineBuffer(3dm), dmFXSplitFields(3dm), dmFXJoinFields(3dm),
  153.      dmGetError(3dm), mvSetMovieRect(3dm).
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.